home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / gfx / board / CyberGrab11.lha / CyberGrab / CyberGrab.doc < prev    next >
Text File  |  1995-05-01  |  6KB  |  188 lines
  1.  
  2.  
  3. Purpose
  4. ~~~~~~~
  5.   If you can answer one of the following questions with "YES"
  6.   you wont need this program:
  7.  
  8.     - You have no Gfx-Board
  9.     - You're not running CyBERgraphics
  10.     - You're not missing some kind of Screen-Grabber
  11.  
  12.   So, you're still here? Ah, you've answered all questions with "NO", ok,
  13.   then read on...
  14.  
  15.   CyberGrab is a utility which allows you to save Screens or Windows as
  16.   "normal" ILBM or ILBM24 files.
  17.   CyberGrab supports all Display-Modes provided by the CyBERgraphics
  18.   system, including 8, 15, 16 and 24 bit modes.
  19.  
  20.  
  21.  
  22. Requirements
  23. ~~~~~~~~~~~~
  24.   - An Amiga, CPU 68020 or better
  25.   - OS 3.0 or better
  26.   - CyBERgraphics 40.46 or better
  27.  
  28.   Note: As CyBERgraphics requires at least a 020er this program has been
  29.   compiled for this processor too.
  30.  
  31.   Also note: Unless you're using screens deeper than 8 bit CyberGrab
  32.   should work without CyberGFX, i.e. can be used with native Amigas too.
  33.   This has however never been tested and is not a recommended usage as it
  34.   will be quite slow because of redundant chunky<->planar conversions.
  35.  
  36.   The amount of memory required depends heavily on the screen (or window)
  37.   you want to grab. For example, for an 800x600x8 image about 500kB will
  38.   be sufficient, while for an 1024x768x24 image you'll need about 2.5MB.
  39.  
  40.  
  41.  
  42. Copyright
  43. ~~~~~~~~~
  44.   CyberGrab is Copyright (c) 1995 by the author Stefan Proels.
  45.  
  46.   CyberGrab is distributed under the concept of Freeware, this means that
  47.   you may redistribute verbatim copies of this archive as long as all
  48.   parts stay complete and unmodified. Unpacking or repacking using another
  49.   archiver is not considered to be a modification as long as all files,
  50.   including their names, are kept intact.
  51.  
  52.   CyberGrab must not be used for military purposes. This includes
  53.   installation on machines used for military purposes.
  54.  
  55.  
  56.  
  57. Installation
  58. ~~~~~~~~~~~~
  59.   Just copy the supplied files to any place you want.
  60.  
  61.  
  62.  
  63. Configuration and Usage
  64. ~~~~~~~~~~~~~~~~~~~~~~~
  65.   You can run CyberGrab from Workbench or from a shell.
  66.   For WB usage you'll have to specify options via tooltypes, otherwise
  67.   you'll have to use commandline parameters.
  68.  
  69.   After you've started CyberGrab it'll wait a little letting you arrange
  70.   what you want to grab (see below). When the time has passed it'll lock
  71.   the screen and grab its image data. Finally the picture will be saved
  72.   as normal ILBM or ILBM24, depending on the screen's depth.
  73.   Note that grabbing a big screen can take some seconds, so don't bother
  74.   when graphical operations on that screen are frozen meanwhile.
  75.  
  76.   The following options are currently supported:
  77.  
  78.   FILE
  79.   ~~~~
  80.     The name of file to write the ILBM to. It should include an absolute
  81.     path, otherwise the file will be saved in CyberGrab's working
  82.     directory (i.e. your current working directory if ran from a shell).
  83.  
  84.     If you do not supply this option a file-requester will be opened
  85.     letting you choose a filename.
  86.  
  87.   ICON/K
  88.   ~~~~~~
  89.     If you want an icon to be created for the FILE you can specify a
  90.     template-icon using this parameter. This icon can contain tooltypes
  91.     and a default tool you want to be invoked when you click on the icon.
  92.     A sample icon named "Template" is supplied with this package.
  93.     By default CyberGrab doesn't create icons.
  94.  
  95.   NUMBER/S
  96.   ~~~~~~~~
  97.     Usually CyberGrab will save the picture in the file specified by the
  98.     FILE option, thereby probably overwriting an existing file. With this
  99.     option however, generated files will be numbered all the way through.
  100.     I.e. the file actually created will be named <FILE>.<n> where <n> is
  101.     the next greatest number of any already existing files matching
  102.     "<FILE>.#[0-9]".
  103.  
  104.     This option is ignored if you do not specify the FILE option in which
  105.     case a file-requester will be opened.
  106.  
  107.   DELAY/K/N
  108.   ~~~~~~~~~
  109.     No. seconds to wait before start grabbing.
  110.     Default: 2.
  111.  
  112.   WINDOW/S
  113.   ~~~~~~~~
  114.     Usually CyberGrab grabs the frontmost screen. If you specify this
  115.     option the currently activated window will be grabbed instead.
  116.  
  117.     NOTE: The operating system provides several types of windows
  118.     (refresh-types, to be more precise) and not all of them can be
  119.     grabbed if they are obscured. Actually, only a few can. Thus, you
  120.     should make sure that the window you wanna grab is completely visible.
  121.     If a part of a window cannot be grabbed because it is hidden it'll
  122.     most probably be colored in background color or be garbled.
  123.     An easy way to ensure "grabablity" is to move the window in front of
  124.     all other windows before running CyberGrab.
  125.  
  126.     ALSO NOTE: An applications can prevent CyberGrab from reading its
  127.     window. Only very few do, though. Actually, I don't know any :-)
  128.     If an application installs custom ClipRects you'll notice the same
  129.     behavior as if a part of the window was obscured.
  130.  
  131.   WINDOWCONTENTS/S
  132.   ~~~~~~~~~~~~~~~~
  133.     This option implies WINDOW but does not grab the window's borders.
  134.  
  135.     NOTE: The operating system provides special windows, called
  136.     "GimmeZeroZero" which "hide" there borders. CyberGrab can detect such
  137.     windows and will always use WINDOWCONTENTS for them, even if you don't
  138.     explicitly specify this option.
  139.  
  140.  
  141.  
  142. History
  143. ~~~~~~~
  144.   1.0   first pre-release
  145.  
  146.   1.1   first public release
  147.  
  148.         * fixed a spelling bug in the program's name |-)
  149.  
  150.         * added image compression
  151.  
  152.         * changed grabbing technique, much faster now but screen gets
  153.           locked longer. Fixed an alignment bug on-the-fly.
  154.  
  155.         * added WINDOW and WINDOWCONTENTS options
  156.  
  157.         * added ICON option
  158.  
  159.         * added NUMBER option
  160.  
  161.         * FILE option is no longer required.
  162.           If not supplied a requester is opened.
  163.  
  164.  
  165.  
  166. Thanks
  167. ~~~~~~
  168.   Special thanks go to Frank Mariak and Thomas Sontowski, the authors
  169.   of CyBERgraphics, who implemented RTG for AmigaOS and therefore are
  170.   the pioneers as well as the front runners on that score.
  171.  
  172.  
  173.  
  174. Author
  175. ~~~~~~
  176.   Send comments, questions, etc., to
  177.  
  178.       Internet: proels@fmi.uni-passau.de
  179.       Fidonet:  Stefan Proels,2:2494/22.13
  180.  
  181.   You may also contact me via snailmail:
  182.  
  183.       Stefan Pröls
  184.       Rudolf-Guby-Str. 1
  185.       94032 Passau
  186.       Germany
  187.  
  188.